Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
WriteComments(Stream,Int32,Generic RasterCollection) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > WriteComments Method : WriteComments(Stream,Int32,Generic RasterCollection) Method



stream
A Stream containing the input file data.
pageNumber
1-based index of the page at which to write the comment.
comments
A collection of RasterCommentMetadata objects containing he comments data.
Writes one or more comments to an existing stream.

Syntax

Visual Basic (Declaration) 
Public Overloads Sub WriteComments( _
   ByVal stream As Stream, _
   ByVal pageNumber As Integer, _
   ByVal comments As RasterCollection(Of RasterCommentMetadata) _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim pageNumber As Integer
Dim comments As RasterCollection(Of RasterCommentMetadata)
 
instance.WriteComments(stream, pageNumber, comments)
C# 
public void WriteComments( 
   Stream stream,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
)
C++/CLI 
public:
void WriteComments( 
   Stream^ stream,
   int pageNumber,
   RasterCollection<RasterCommentMetadata> comments
) 

Parameters

stream
A Stream containing the input file data.
pageNumber
1-based index of the page at which to write the comment.
comments
A collection of RasterCommentMetadata objects containing he comments data.

Example

For an example, refer to ReadComment.

Remarks

This function only applies to TIF, uncompressed EXIF, or FPX files.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the comment. See the Loading and Saving Large Tiff Files topic for more information.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also